Improvement: Adds field PeriodicTask.origin_key to sync tasks defined in source code with settings.beat_schedule #136
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…asks that are deleted from settings.beat_schedule in source code Bugfix: changing schedule class in settings.CELERYBEAT_SCHEDULE will no longer create a second (or third) schedule in PeriodicTask instance
auvipy
requested changes
Mar 23, 2018
liquidpele
suggested changes
May 2, 2019
| } | ||
| schedules[model_field] = model_schedule | ||
|
|
||
| entry.update(**schedules) | ||
| entry.update( |
There was a problem hiding this comment.
So this will run two queries instead of one now? It would be nicer to keep it as one.
| ) | ||
| existing_tasks = set( | ||
| map(lambda x: x.name, existing_task_instances) | ||
| ) |
There was a problem hiding this comment.
Could replace a lot of logic here with just this I think:
tasks_to_purge = PeriodicTask.objects.filter(
origin_key=origin_key).exclude(name__in=mapping.keys())
if tasks_to_purge:
tasks_to_purge.delete()
log.warn(...)
| class Migration(migrations.Migration): | ||
|
|
||
| dependencies = [ | ||
| ('django_celery_beat', '0006_auto_20180210_1226'), |
There was a problem hiding this comment.
Other migrations has been added, you'll need to rebase this to be the next one in the list based on what's in the master branch.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a field
PeriodicTask.origin_keywhich indicates if a task database row was populated dynamically or from source code (e.g.settings.CELERYBEAT_SCHEDULEorsettings.beat_schedulein4.1+).If an entry is removed from
settings.CELERYBEAT_SCHEDULEit will also delete any previously populated database row forPeriodicTask.E.g.
After commenting out the above, celery beat would purge the task from database and also emit this logger statement:
I also updated the scheduler to only ingest one and only one schedule when reading
settings.CELERYBEAT_SCHEDULE. The old behavior was that if you re-wrote an interval schedule to a cron schedule, it would remain associated with the old (now deleted) interval schedule and be called for both schedules. E.g.: